PPluginCall

A class that provides a framework for the calls from PageMaker. You can create a subclass of PPluginCall and override one or more member functions to implement the behavior of your plug-in.

Constructor


PPluginCall();

The default constructor stores a pointer to the sPMParamBlock and PMMessage structures. This constructor is protected, to restrict this class being created except as a base class.

Member functions


void Dispatch();

Based on the opcode in the sPMMessage, calls either DoLoad, DoRegister, DoInvoke, DoEvent, DoSysEvent, DoAcquireInterface, DoReleaseInterface, DoUnload, or DoShutdown.


void BuildErrorMessages(const char * errText, const char * cantText = NULL);

If you want PageMaker to display custom error text when an error is returned from a plug-in, set the error text using this function.


short GetOpCode();

If you need to know the opCode for some reason.


unsigned long GetSubCode();

If you need to know the subCode.


void * GetPluginData();

This returns a pointer to the plug-in's private data structure. You are responsible for allocating and releasing the memory used for any plug-in private data.


void SetPluginData(void * h);

Set the plug-in's private data.


operator const sPMParamBlock&();

You can treat this class as if it were a sPMParamBlock to get fields from the structure.


virtual void DoLoad();

If you want to perform any action during the load phase, you should override this function. The default action is to do nothing.


virtual void DoRegister();

If you want to perform any action during the register phase, you should override this function. The default action is to do nothing.
Note that a plug-in will only receive a register call if it has indicated in its ADNI resource that it wants to register for one or more PageMaker events.
Typically, if you override the DoRegister() function, you will acquire and use the CIEvent interface to register your plug-in to receive events from PageMaker.


virtual void DoInvoke();

If you want to perform any action during the invoke phase, you should override this function. The default action is to do nothing.
For many plug-ins, the only function they may override is DoInvoke(); it is where all a plug-ins actions occur.


virtual void DoEvent();

If you want to perform any action in response to an event from PageMaker, you should override this function. The default action is to do nothing.
To receive DoEvent calls, you must register for events in the DoRegister call


virtual void DoSysEvent();

If you want to perform any action in response to a system event, you should override this function. The default action is to do nothing.


virtual void DoAcquireInterface();

A client is requesting an interface that this plug-in published. Override this function to supply the interface pointer back to the client. If the interface needs memory, you can allocate it using the PageMaker memory functions.
The default action is to do nothing.


virtual void DoReleaseInterface();

A client is done with an interface published by the plug-in. Override this function if you need to release memory used by the interface.
The default action is to do nothing.


virtual void DoUnload();

If you want to perform any action during the unload phase, you should override this function. The default action is to do nothing.


virtual void DoShutdown();

If you want to perform any action during the shutdown phase, you should override this function. The default action is to do nothing.

Comments or suggestions? Contact Adobe Developer Support